/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/**
 * REST api abstract interface
 *
 * @example
 * ```typescript
 * const res = Rest<{userName: string, password: string}>;
 *
 * // res.result.userName is string
 * // res.result.password is string
 * ```
 */
export interface Rest<T> {
  /**
   * request result
   */
  result: T;
  /**
   * request http status code
   */
  code: number;
  message: string;
  status: string;
  success: boolean;
}

/**
 * Array result
 */
export interface ListResult<T> {
  /**
   * result list
   */
  records: T[];
  /**
   * result list length
   */
  total: number;
}
